Skip to content

added script and html for Documenter Navigation #77

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 7 commits into from
Jun 21, 2024

Conversation

shravanngoswamii
Copy link
Member

@shravanngoswamii shravanngoswamii commented Jun 21, 2024

Now we have to add this line after makedocs() function in docs/make.jl of each package:

# Insert navbar in each html file
run(`sh -c "curl -s https://raw.githubusercontent.com/TuringLang/turinglang.github.io/main/assets/scripts/insert_navbar.sh | bash -s docs/build"`)

I avoided generating template from yml for this because we will not be changing Navigation elements for many months or maybe years until some new package is added in Turing ecosystem! So generating template from yml wil just increase the files and workflow runtime, It's better to do this in way I did currently! I tested it on multiple packages its working fine and very smoothly!

@shravanngoswamii
Copy link
Member Author

opened PR in AbstractMCMC.jl for adding Navigation bar, merge that after this PR is merged

@shravanngoswamii shravanngoswamii requested a review from yebai June 21, 2024 13:22
@shravanngoswamii
Copy link
Member Author

  1. MCMC/ThermodynamicIntegration docs main link is broken, I guess it's author have not renewed the domain and github is still redirecting to custom domain, just need a minor github pages setting or else domain renewal.
    link — https://theogf.github.io/ThermodynamicIntegration.jl/

Other Issues I found:

  1. Broken Link - MCMC/EllipticalSliceSampling.jl

@yebai
Copy link
Member

yebai commented Jun 21, 2024

@shravanngoswamii let's link to https://github.com/theogf/ThermodynamicIntegration.jl for ThermodynamicIntegration instead.

Co-authored-by: Hong Ge <3279477+yebai@users.noreply.github.com>
Copy link
Member

@yebai yebai left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good -- feel free to merge!

@shravanngoswamii
Copy link
Member Author

shravanngoswamii commented Jun 21, 2024

Looks good -- feel free to merge!

Actually, I am not authorized to merge in this repo, I only have permission on docs repo!

@shravanngoswamii
Copy link
Member Author

Can you also merge this one — TuringLang/AbstractMCMC.jl#141

@yebai yebai merged commit a7c1f47 into TuringLang:main Jun 21, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants